<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>SPHinXsys: SPH::BaseLevelSet Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">SPHinXsys
   &#160;<span id="projectnumber">alpha version</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespace_s_p_h.html">SPH</a></li><li class="navelem"><a class="el" href="class_s_p_h_1_1_base_level_set.html">BaseLevelSet</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="class_s_p_h_1_1_base_level_set-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">SPH::BaseLevelSet Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">

<p>A abstract describes a level set field defined on a mesh.  
 <a href="class_s_p_h_1_1_base_level_set.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="level__set_8h_source.html">level_set.h</a>&gt;</code></p>

<p>Inherits <a class="el" href="class_s_p_h_1_1_base_mesh_field.html">SPH::BaseMeshField</a>.</p>

<p>Inherited by <a class="el" href="class_s_p_h_1_1_mesh_with_grid_data_packages.html">SPH::MeshWithGridDataPackages&lt; BaseLevelSet, LevelSetDataPackage &gt;</a>, and <a class="el" href="class_s_p_h_1_1_multilevel_mesh.html">SPH::MultilevelMesh&lt; BaseLevelSet, LevelSet, RefinedLevelSet &gt;</a>.</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a79a5efcd302e8a496f0dcc147174af8a"><td class="memItemLeft" align="right" valign="top"><a id="a79a5efcd302e8a496f0dcc147174af8a"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>BaseLevelSet</b> (<a class="el" href="class_s_p_h_1_1_shape.html">Shape</a> &amp;shape, <a class="el" href="class_s_p_h_1_1_s_p_h_adaptation.html">SPHAdaptation</a> &amp;sph_adaptation)</td></tr>
<tr class="separator:a79a5efcd302e8a496f0dcc147174af8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5f12c597aad88e6972edc157a47645ba"><td class="memItemLeft" align="right" valign="top"><a id="a5f12c597aad88e6972edc157a47645ba"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>cleanInterface</b> (Real small_shift_factor)=0</td></tr>
<tr class="separator:a5f12c597aad88e6972edc157a47645ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7884274a9eb276f2e0e24e815b814b65"><td class="memItemLeft" align="right" valign="top"><a id="a7884274a9eb276f2e0e24e815b814b65"></a>
virtual <a class="el" href="classbool.html">bool</a>&#160;</td><td class="memItemRight" valign="bottom"><b>probeIsWithinMeshBound</b> (const Vecd &amp;position)=0</td></tr>
<tr class="separator:a7884274a9eb276f2e0e24e815b814b65"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7c261342957a0957d93fffb32dee1435"><td class="memItemLeft" align="right" valign="top"><a id="a7c261342957a0957d93fffb32dee1435"></a>
virtual Real&#160;</td><td class="memItemRight" valign="bottom"><b>probeSignedDistance</b> (const Vecd &amp;position)=0</td></tr>
<tr class="separator:a7c261342957a0957d93fffb32dee1435"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8aa5c01d6d72c2510a3a3055c9ee4c78"><td class="memItemLeft" align="right" valign="top"><a id="a8aa5c01d6d72c2510a3a3055c9ee4c78"></a>
virtual Vecd&#160;</td><td class="memItemRight" valign="bottom"><b>probeNormalDirection</b> (const Vecd &amp;position)=0</td></tr>
<tr class="separator:a8aa5c01d6d72c2510a3a3055c9ee4c78"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a40ac4e3a522936af54a7b872e3195e77"><td class="memItemLeft" align="right" valign="top"><a id="a40ac4e3a522936af54a7b872e3195e77"></a>
virtual Vecd&#160;</td><td class="memItemRight" valign="bottom"><b>probeLevelSetGradient</b> (const Vecd &amp;position)=0</td></tr>
<tr class="separator:a40ac4e3a522936af54a7b872e3195e77"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9e528f5a690edf75451baeba53b31b23"><td class="memItemLeft" align="right" valign="top"><a id="a9e528f5a690edf75451baeba53b31b23"></a>
virtual Real&#160;</td><td class="memItemRight" valign="bottom"><b>probeKernelIntegral</b> (const Vecd &amp;position, Real h_ratio=1.0)=0</td></tr>
<tr class="separator:a9e528f5a690edf75451baeba53b31b23"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad4b08029c3b2c5a00a2d7eabcfb91609"><td class="memItemLeft" align="right" valign="top"><a id="ad4b08029c3b2c5a00a2d7eabcfb91609"></a>
virtual Vecd&#160;</td><td class="memItemRight" valign="bottom"><b>probeKernelGradientIntegral</b> (const Vecd &amp;position, Real h_ratio=1.0)=0</td></tr>
<tr class="separator:ad4b08029c3b2c5a00a2d7eabcfb91609"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_s_p_h_1_1_base_mesh_field"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_s_p_h_1_1_base_mesh_field')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_s_p_h_1_1_base_mesh_field.html">SPH::BaseMeshField</a></td></tr>
<tr class="memitem:a4082c89e76d3475b1baf004e6f693f96 inherit pub_methods_class_s_p_h_1_1_base_mesh_field"><td class="memItemLeft" align="right" valign="top"><a id="a4082c89e76d3475b1baf004e6f693f96"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>BaseMeshField</b> (const std::string &amp;name)</td></tr>
<tr class="separator:a4082c89e76d3475b1baf004e6f693f96 inherit pub_methods_class_s_p_h_1_1_base_mesh_field"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a99836246319d1b9faa6bc3984cf27e1d inherit pub_methods_class_s_p_h_1_1_base_mesh_field"><td class="memItemLeft" align="right" valign="top"><a id="a99836246319d1b9faa6bc3984cf27e1d"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>Name</b> ()</td></tr>
<tr class="separator:a99836246319d1b9faa6bc3984cf27e1d inherit pub_methods_class_s_p_h_1_1_base_mesh_field"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a732206129d127c3daf05b2092aa683c2 inherit pub_methods_class_s_p_h_1_1_base_mesh_field"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_base_mesh_field.html#a732206129d127c3daf05b2092aa683c2">writeMeshFieldToPlt</a> (std::ofstream &amp;output_file)=0</td></tr>
<tr class="separator:a732206129d127c3daf05b2092aa683c2 inherit pub_methods_class_s_p_h_1_1_base_mesh_field"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a83ab6a0b58428b5a34b8325d63ea9976"><td class="memItemLeft" align="right" valign="top">Real&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_base_level_set.html#a83ab6a0b58428b5a34b8325d63ea9976">computeHeaviside</a> (Real phi, Real half_width)</td></tr>
<tr class="separator:a83ab6a0b58428b5a34b8325d63ea9976"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a51d40c166d908d955e0dc89e55111224"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_s_p_h_1_1_shape.html">Shape</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_base_level_set.html#a51d40c166d908d955e0dc89e55111224">shape_</a></td></tr>
<tr class="separator:a51d40c166d908d955e0dc89e55111224"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af99c93a87ba5fe3ee81a78d1b3523166"><td class="memItemLeft" align="right" valign="top"><a id="af99c93a87ba5fe3ee81a78d1b3523166"></a>
<a class="el" href="class_s_p_h_1_1_s_p_h_adaptation.html">SPHAdaptation</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>sph_adaptation_</b></td></tr>
<tr class="separator:af99c93a87ba5fe3ee81a78d1b3523166"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_attribs_class_s_p_h_1_1_base_mesh_field"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_class_s_p_h_1_1_base_mesh_field')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="class_s_p_h_1_1_base_mesh_field.html">SPH::BaseMeshField</a></td></tr>
<tr class="memitem:a0e49422f87e826b50b3f02bf9c8ad9c4 inherit pro_attribs_class_s_p_h_1_1_base_mesh_field"><td class="memItemLeft" align="right" valign="top"><a id="a0e49422f87e826b50b3f02bf9c8ad9c4"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>name_</b></td></tr>
<tr class="separator:a0e49422f87e826b50b3f02bf9c8ad9c4 inherit pro_attribs_class_s_p_h_1_1_base_mesh_field"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A abstract describes a level set field defined on a mesh. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a83ab6a0b58428b5a34b8325d63ea9976"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a83ab6a0b58428b5a34b8325d63ea9976">&#9670;&nbsp;</a></span>computeHeaviside()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">Real SPH::BaseLevelSet::computeHeaviside </td>
          <td>(</td>
          <td class="paramtype">Real&#160;</td>
          <td class="paramname"><em>phi</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">Real&#160;</td>
          <td class="paramname"><em>half_width</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>for computing volume fraction occupied by a shape. </p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a51d40c166d908d955e0dc89e55111224"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a51d40c166d908d955e0dc89e55111224">&#9670;&nbsp;</a></span>shape_</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_s_p_h_1_1_shape.html">Shape</a>&amp; SPH::BaseLevelSet::shape_</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>the geometry is described by the level set. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>SPHINXsys/src/shared/geometries/<a class="el" href="level__set_8h_source.html">level_set.h</a></li>
<li>SPHINXsys/src/shared/geometries/<a class="el" href="level__set_8cpp.html">level_set.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>
